// $Id: XMLElement.java 1153 2008-11-30 16:14:45Z bobtarling $
// Copyright (c) 1996-2006 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.tigris.gef.persistence;

import org.xml.sax.Attributes;
import org.xml.sax.helpers.AttributesImpl;

/**
 * @author Jim Holt
 */
public class XMLElement {

    // //////////////////////////////////////////////////////////////
    // instance variables

    private String name = null;
    private StringBuffer text = new StringBuffer(100);
    private Attributes attributes = null;

    /**
     * Constructor.
     * 
     * @param n
     *                The name of the element.
     * @param a
     *                The attributes.
     */
    public XMLElement(String n, Attributes a) {
        name = n;
        attributes = new AttributesImpl(a);
    }

    // //////////////////////////////////////////////////////////////
    // accessors

    /**
     * @return the name of this element
     */
    public String getName() {
        return name;
    }

    /**
     * @param n
     *                the name of this element
     */
    public void setName(String n) {
        name = n;
    }

    /**
     * @param t
     *                the text to be appended
     */
    public void addText(String t) {
        text = text.append(t);
    }

    /**
     * @param t
     *                the new text
     */
    public void setText(String t) {
        text = new StringBuffer(t);
    }

    /**
     * Erase the text of this element.
     */
    public void resetText() {
        text.setLength(0);
    }

    /**
     * @return the text of this element
     */
    public String getText() {
        return text.toString();
    }

    /**
     * Change the attributes for this element.
     * 
     * @param a
     *                The new list of attributes.
     */
    public void setAttributes(Attributes a) {
        attributes = new AttributesImpl(a);
    }

    /**
     * @param attribute
     *                the attribute name
     * @return the attribute value
     */
    public String getAttribute(String attribute) {
        return attributes.getValue(attribute);
    }

    /**
     * @param i
     *                the index for the list of attributes
     * @return the attribute name for the attribute at the given index
     */
    public String getAttributeName(int i) {
        return attributes.getLocalName(i);
    }

    /**
     * @param i
     *                the index for the list of attributes
     * @return the attribute value for the attribute at the given index
     */
    public String getAttributeValue(int i) {
        return attributes.getValue(i);
    }

    /**
     * @return the number of attributes
     */
    public int getNumAttributes() {
        return attributes.getLength();
    }

} /* end class XMLElement */
